WorldClient Pro © 1999-2000 Alt-N Technologies. All Rights Reserved.
WorldClient's INI File

This section contains a list of the WorldClient.ini file sections, and descriptions of the various controls within each section. The file is located in WorldClient Pro's base directory, and can be manually edited with any text editor, or by using the Remote Administration interface (see page 54).

The WorldClient.ini file contains the following sections:

The configuration settings for both WorldClient Pro and the WorldClient Administration Utility are stored in the WorldClient Pro INI file. This section contains a list of the WorldClient.ini file sections, and descriptions of the various controls within each section. The file is located in WorldClient Pro's base directory, and can be manually edited with any text editor, or by using the Remote Administration interface.

The WorldClient.ini file contains the following sections:

• General - Contains controls governing several of WorldClient Pro's general settings.

• Registration - Contains registration information.

• AccountCreation - Settings specific to WorldClient Pro and email account creation.

• Directories - File paths to WorldClient Pro's various directories.

• WebServer - Contains settings specific to the WorldClient Pro web server, which listens to WorldClient Pro requests. Also contains settings related to performance and thread usage of the WorldClient Pro web server.

• AdminWebServer - Settings specific to the WorldClient Remote Administration web server, which listens to all WorldClient Admin requests.

• Version - This section contains version information regarding WorldClient Pro's various components. You cannot edit these controls; they will be overwritten each time you start WorldClient Pro.

• POPClient - This section contains timeout controls and initial POP session message size limits for WorldClient Pro's POP client.

• SmtpClient - Contains the settings for WorldClient Pro's SMTP connections.

• Session - Here you will designate the maximum number of user sessions that can be active at the same time, and the maximum amount of time that a session can remain idle before it will expire.

• WCAdmin - This section contains settings that govern the WorldClient Administration Utility.

• LDAPAuth - Settings for authenticating users to an LDAP server. This is only done for users with a "*" as the first character of the Password field in their User.ini.

• SpellCheck - This section contains spell check options that are language dependent.

• Mailboxes - Settings governing the maximum number of user mailboxes and whether or not to synchronize WorldClient with the default POP server are contained in this section.

• Special - Contains any special or miscellaneous keys.

General
This section of the WorldClient Pro INI file contains controls governing several of WorldClient Pro's general settings.

• LogLevel - A number (1 through 4) representing the log file verbosity. A lower number means more verbose. 1 = Most Verbose, 4 = Least Verbose.

• ListDateFormat - This control requires strftime formatting codes for displaying the date/time in the Message Listing. The default setting is: %m/%d %H:%M. For a list of the codes see: Date/Time Formatting Codes.

• MessageDateFormat - This control requires strftime formatting codes for displaying the date/time in the Message View. The default setting is: %x %X. For a list of the codes see: Date/Time Formatting Codes.

• RedirectWait - This is the time interval (in seconds) that WorldClient Pro will wait before refreshing the "Please Wait..." message that is displayed to users while their messages are being checked for and/or collected. This message will state which server it is connecting to and how many messages have been collected since it began downloading them. # = Number of seconds before refreshing.

• EnableReplaceFrom - This control makes it possible for you to specify whether or not you want the From column to be replaced by the To column in your users' Drafts and Sent folders. By default it will be replaced. No = Off/No replace, Yes = On/Replace.

• MaxLogFileSize - Maximum file size (in Kbytes) for each WorldClient log file before starting a new one. The current file is renamed to *.OLD and the *.LOG file starts over. Default = 1000.

• LogRotation - Set this to DAILY, WEEKLY, or MONTHLY to have WorldClient Pro start new log files at certain time intervals. If used, the log files will be called "WC[yyyymmdd].LOG" and "WD[yyyymmdd].LOG" instead of "WorldClient.LOG" and "WDaemon.LOG".

• MaxInlineAttachSize - Maximum file size (in Kbytes) of text files that are shown inline along with the messages. Default is 20.

• CaseSensitivePasswords - Controls whether or not the WorldClient Pro sign-in passwords are case-sensitive. Yes = Passwords are case-sensitive, No = passwords are not case-sensitive. Default is Yes.

• SendReadConfirmations - Determines whether or not WorldClient Pro will send read confirmation messages in response to messages that request it. Yes = Reply to read confirmation requests, No = Do not reply to requests. Default is No.

• GlobalAddrBookSortOrder - This key is used to designate the order by which Global Address Book entries will be sorted. Accepts: Name, RevName, EMail, RevEMail, Comment, RevComment, and User. The User value will cause the Global Address Book to be sorted by whichever column that the user's personal Address Book entries are being sorted. Default setting is Name.

• VerboseSentConfirmation - When this key is set to "Yes", the "Message Sent" message will also display the contents of the "To:" and "Subject:" fields of the outgoing message. Yes = Include headers, No = Don't include.

• RunAsService - Determines whether the WorldClient Server will run as a system service. Default is Yes.

• CacheTemplates - This key governs whether or not WorldClient will cache its Template files. If you choose No in this control then the template files will be loaded from disk each time that WorldClient receives a request. The option to turn off template caching is useful when you are editing templates and want to review your changes without having to restart WorldClient to do so. It is recommended that you do not turn off template caching during normal operation as this can slow down server efficiency. Default is Yes.

Registration

• Key - Your WorldClient Pro registration key. Type your registration key here to activate the registered version of WorldClient Pro. The maximum number of user accounts allowable is determined by this key. To obtain a Registration Key, contact sales@worldclient.com or visit www.worldclient.com.

• MaxUsers - The maximum number of user accounts allowed by your version of WorldClient Pro. This number is written by WorldClient during installation and cannot be edited. To obtain a Registration Key that will allow a larger number of users, contact sales@worldclient.com or visit www.worldclient.com.

• Administrator - The email address of the WorldClient Pro administrator that you entered during installation.

• Name - The full name that you entered during installation.

• Company - The company name that you entered during installation.

AccountCreation

• NewUserNotification - Controls whether WorldClient Pro will send an email notification to the administrator when a new account is created. Yes = Notify, No = Do not Notify. Default is No.

• SendWelcomeMessage - Set this control to "Yes" if you would like a welcome message to be sent to new users. A SendWelcome=Yes key will be created in the [User] section of the user's INI file, which will cause the welcome message to be sent the first time that the new user logs in to WorldClient. After the message has been sent, the SendWelcome key will be deleted. The welcome message is created from the Welcome.msg file contained in WorldClient's base directory. This file must be in RFC822 format, and you can use the <$USERNAME$>, <$FULLNAME$>, and <$EMAIL$> tags to personalize it. Yes = Send welcome message, No = Do not send message. Default is No.

• NTLogonName - If you are using an add user utility specified in the NewAccountExecutable key in the domains.ini file, and it needs access to any network shares, then you must use an NT user account with sufficient administrative privileges to access those shares. Specify that account's logon name here.

• NTPassword - This is the password of the NT account being used to access network shares.

• NTDomain - This is the NT domain to which the account belongs that you are using to access network shares.

Directories
This section contains the file paths to WorldClient Pro's various directories. If your platform is Windows NT and you specify a path to a network shared drive anywhere in WorldClient Pro, you will need to change the WorldClient Pro Service from a System Account to a User Account with administrative privileges (Local System Account will not provide access to these drives). For more information see: Services.

• BaseDir - WorldClient Pro's root directory. Default is [drive]:\Program Files\WorldClient

• LogDir - The Log file directory. Default is [drive]:\Program Files\WorldClient\Logs

• TempDir - Directory to use when creating temporary directories/files. Default is [drive]:\Program Files\WorldClient\Temp

• UserDir - The directory where user subdirectories should be created. Default is [drive]:\Program Files\WorldClient\Users

• TemplateDir - WorldClient Pro's templates directory. WorldClient Pro's template files are stored here in individual Themes subdirectories. This is also the directory where the languages.ini file is stored. This file is used by WorldClient to replace English text in the Templates when an alternate language has been chosen. Default is [drive]:\Program Files\WorldClient\Templates

• SpellDir - WorldClient Pro spell checker's base directory. Default is [drive]:\Program Files\WorldClient\SpellCheck

• MDaemonAppDir - This is the path to the directory containing MDUSER.DLL, which is used to synchronize WorldClient and MDaemon accounts. This key should be automatically created when synchronization is turned on in MDaemon.

WebServer
Contains settings specific to the WorldClient Pro web server, which listens to WorldClient Pro requests.

• CgiDir - The path to the directory where CGI executables for WorldClient Pro's web server are located and can be placed. Default is [drive]:\Program Files\WorldClient\cgi-bin.

• CgiAlias - What CGI requests start with. Default is /cgi-bin.

• HtmlDir - Directory where HTML files and image files are located. Default is [drive]:\Program Files\WorldClient\HTML

• DefHtmlFile - Default file to load in each directory if not specified. Default is index.html.

• Auth - Encrypted authorization string for all web requests. The authorization string is of the format username:password, and the password value is case sensitive. Prefix this with a "-" and WorldClient Pro will encrypt it for you the next time it is accessed. If blank, it doesn't require authorization.

• LocalAuth - This setting governs whether or not authorization will be required when a request is made from the local computer (127.0.0.1). No = Don't ask for authorization, Yes = authorization required. Default is No.

• CgiBase[1-50] - What the HTTP request starts with. (e.g. /WorldClient.cgi)

• CgiFile[1-50] - The DLL or EXE to run when the CGI is requested. (e.g. c:\...\WorldClient.dll)

• CgiAuth[1-50] - An authorization string (like the "Auth" key above), but only affecting this CGI. Authorization should either be per CGI, or for the entire web server, but not both.

The following controls deal with thread usage of the WorldClient Pro web server. These controls are mainly applicable to higher volume sites:

• MinThreads - Minimum number of threads in the thread pool.

• MaxThreads - Maximum number of threads in the thread pool (max concurrent requests). WorldClient Pro will add threads to the pool as needed but will never add threads beyond this threshold. If an HTTP request is received while the maximum number of threads is already active, an HTTP error message will be sent to the client.

• ThreadTimeout - Time (in seconds) before an idle thread exits the thread pool.

AdminWebServer
Contains settings specific to the WorldClient Administration web server, which listens to all WorldClient Admin requests.

• CgiDir - The path to the directory where CGI executables for the Admin server are located. Default is [drive]:\Program Files\WorldClient\Admin-cgi.

• CgiAlias - What CGI requests start with. Default is /cgi-bin.

• HtmlDir - Directory where HTML files and image files for the Admin web server are located. Default is [drive]:\Program Files\WorldClient\HTML

• Port - Port to listen on for HTTP requests to the WorldClient Admin server. Default is 2001

• BindAddress - To bind to a specific IP address, change this control to the IP address to which you wish to bind the WorldClient Admin server. By default the Admin server will bind to all local interfaces. You will have to stop and restart the WorldClient service in order for any changes to take effect. 0.0.0.0 = Bind to all local

• DefHtmlFile - Default file to load in each directory if not specified. Default is index.html.

• Auth - Encrypted authorization string for all Admin web requests. The authorization string is of the format username:password, and is case sensitive. Prefix this with a "-" and WorldClient Pro will encrypt it for you the next time it is accessed. If blank, it doesn't require authorization. Default is -Admin:WorldClient.

• LocalAuth - This setting governs whether or not authorization will be required when a request is made from the local computer (127.0.0.1). No = Don't ask for authorization, Yes = authorization required. Default is No.

Version
This section contains version information regarding WorldClient Pro's various components. You cannot edit these controls; they will be overwritten each time you start WorldClient Pro.

POPClient
This section contains timeout controls and initial POP session message size limits for WorldClient Pro's POP client.

• Timeout - Time (in seconds) of inactivity before a POP3 connection times out.

• RetrCutoff - Max size (in bytes) of messages to retrieve full body (not just headers) in initial pop session. Messages larger than this number will only have their headers retrieved until a user attempts to read the message; then it will be downloaded. 8192 = Default Max Size to immediately download, 0 = Retrieve all messages.

• UseReceivedDate - Gets a message's date from the received header rather than the Date header. Yes = Use received header date, No = Use Date header. Default is Yes.

SmtpClient

• HeloDomain - Domain to use in the SMTP session HELO statement. Default is "WorldClient".

• UseESMTP - This key enables support for ESMTP Message Size Declaration extension. Set this key to "No" if you are not using an ESMTP server, or if you do not want to use this feature. Yes = Use ESMTP size declaration, No = Do not use ESMTP size declaration. Default is Yes.

Session
Here you will designate the maximum number of user sessions that can be active at the same time, and the maximum amount of time that a session can remain idle before it will expire. This section also contains keys that aid in session security.

• Maximum - This is the maximum number of users that may be logged in to WorldClient Pro at the same time (i.e. maximum active sessions). Default is 200.

• ExpireTime - Time (in minutes) that an active session may remain idle before WorldClient Pro will kill it. This is equivalent to WorldClient Pro logging out the user. Composing messages can result in larger idle times, therefore whenever a user is in any of the Compose views, the ComposeExpireTime timer will apply rather than this one. Default is 20.

• ComposeExpireTime - This is the amount of time (in minutes) that a user may remain in one of the Compose views before their session will expire. Default is 120. Note: If a user attempts to send a message after their session has timed out, the text will be saved as a Draft message that can be resumed after the user logs back in to WorldClient.

• CheckCookie - When this key is set to "Yes", only session requests sending the correct cookie value for that session will be honored. The cookie is generated by the server when the session is created. If this check fails, the user trying to access WorldClient will be taken to the Logon screen. This aids in making sure that only the user who logged in to the session will be able to access it. Both this key and the CheckIP key that follows can greatly aid in securing your user's mail and access. Default is Yes. Default is Yes.

• CheckIP - With this key set to "Yes", all session requests must come from the same IP that was used when the session was created. If this check fails, the user trying to access WorldClient will be taken to the Logon screen. This aids in making sure that only the user who logged in to the session will be able to access it. Both this key and the CheckCookie key above can greatly aid in securing your user's mail and access. Default is Yes.

WCAdmin
This section contains settings that govern the WorldClient Administration Utility.

• HelpURL - Contains the path to the Admin Help System.

LDAPAuth
Settings for authenticating users to an LDAP server. This is only done for users with a "*" as the first character of the Password field in their User.ini.

• Host - LDAP host to which you authenticate (e.g. ldap.domain.com).

• TimeLimit - Seconds to wait before timing out. Default is 5.

• SizeLimit - Max records to request Default is 1.

• Base - Base name for LDAP query.

• Filter - Filter for LDAP query. USER is replaced with the login name. Example: Filter=(cn=USER).

• NameAttr - LDAP attribute for the user name (e.g. NameAttr=cn).

• PassAttr - LDAP attribute for the password, must be plain text (e.g. PassAttr=password).

SpellCheck
These INI options are comma separated lists of languages that the option applies to.

• SplitWords - Whether the spell check should attempt to break misspelled words into a series of shorter, correctly spelled words. Default is de.

• SplitContractedWords - Whether the spell check should treat apostrophes as word separators and check each word separately. Default is fr,fc,it.

• SuggestSplitWords - Whether the spell check should suggest two shorter words formed by splitting the misspelled word. Default is en.

• NoAccentedCaps - Lists the language codes for certain languages which do not use accents in capital letters. For example, French uses accents while French Canadian does not. Therefore the spell checker will not treat French Canadian words as misspelled when the accents do not occur. Default=fc.

• AddSingleWords - This key is for controlling whether users will be able to add words to their dictionary during the spell checking process. When it is set to Yes, there will be a plus sign next to each drop-down box that appears for misspelled or unknown words during spell checking. Clicking the plus sign will cause the unknown word to be added to the user's dictionary. When this control is set to No, they will be unable to add words from the spell check page. Default is Yes.

RelayFax
WorldClient/RelayFax integration is governed by the keys in this section.

• UseRelayFax - When set to Yes, WorldClient integration with Alt-N Technologies' RelayFax server is enabled. The original setting of this key (Yes or No) is determined during WorldClient's installation. See WorldClient/RelayFax integration for more information.

• FaxEmail - By default this key will not appear in the WorldClient.ini file unless you provided a specific email address during WorldClient installation. This is the email address to which WorldClient will deliver messages that are composed using the Compose Fax page, which is accessible when WorldClient/RelayFax integration is enabled. When this key isn't present in the [RelayFax] section of the INI file, WorldClient will deliver Compose Fax messages to your local RelayFax directly instead of using the email delivery method. If you add this key later it should be in the form: FaxEmail=mailbox@domain.

• AppPath - By default this key will not appear in the WorldClient.ini file unless you provided it during WorldClient installation. When WorldClient/RelayFax integration is enabled, WorldClient will automatically determine the path to RelayFax when it is installed locally. However, if your RelayFax server is installed on another machine then this key can be used to supply the UNC file path to its \app\ directory. If you add this key later it should be in the form: AppPath=\\machine\path. For more information see WorldClient/RelayFax integration.

Special
Contains any special or miscellaneous keys.

• SendMessageAttachmentsAsText - When set to Yes, WorldClient will send files of content-type "message/rfc822" as "text/plain" instead. This is necessary due to certain browser incompatibilities resulting from messages with "message/rfc822" attachments. Default is Yes.

• UseCookies - Controls whether WorldClient will set and use cookies for certain functions. No=do not use cookies. Default is Yes.